<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Electron Settings - v5.0.0</title><meta name="description" content="Documentation for Electron Settings"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
<div class="tsd-toolbar-contents container">
<div class="table-cell" id="tsd-search" data-base=".">
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
<div class="field">
<div id="tsd-toolbar-links"></div></div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">Electron Settings - v5.0.0</a></div>
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
<div class="container container-main">
<div class="col-content">
<div class="tsd-page-title">
<h2>Electron Settings - v5.0.0</h2></div>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Properties</h3>
<div class="tsd-index-list"><a href="index.html#export_" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>export=</span></a>
</div></section></div></details></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member"><a id="export_" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>export=</span><a href="#export_" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">export=</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">configure</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">customConfig</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">file</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">get</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">SettingsObject</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">SettingsValue</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getSync</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">SettingsObject</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">SettingsValue</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">has</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">hasSync</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">reset</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">set</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span>, <span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">setSync</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">unset</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">unsetSync</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-kind-property">configure</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">customConfig</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures">
<li class="tsd-signature" id="export_.__type.configure.__type-1.__type-2"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">customConfig</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Sets the configuration for Electron Settings. To reset
to defaults, use [[reset|reset()]].</p>
<p>Defaults:</p>
<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-1">atomicSave</span><span class="hl-0">: </span><span class="hl-2">true</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-1">fileName</span><span class="hl-0">: </span><span class="hl-3">&#39;settings.json&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-1">numSpaces</span><span class="hl-0">: </span><span class="hl-4">2</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-1">prettify</span><span class="hl-0">: </span><span class="hl-2">false</span><br/><span class="hl-0">}</span>
</code></pre>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Update</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">filename</span><span class="hl-0"> </span><span class="hl-5">to</span><span class="hl-0"> </span><span class="hl-3">`cool-settings.json`</span><span class="hl-0"> </span><span class="hl-5">and</span><span class="hl-0"> </span><span class="hl-5">prettify</span><br/><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">output</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">configure</span><span class="hl-0">({</span><br/><span class="hl-0">      </span><span class="hl-5">fileName:</span><span class="hl-0"> </span><span class="hl-3">&#39;cool-settings.json&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-5">prettify:</span><span class="hl-0"> </span><span class="hl-2">true</span><br/><span class="hl-0">    });</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">customConfig</span>: <span class="tsd-signature-type ">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Config</span><span class="tsd-signature-symbol">&gt;</span></h5>
<div class="tsd-comment tsd-typography"><p>The custom configuration to use.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li>
<li class="tsd-parameter">
<h5><span class="tsd-kind-property">file</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures">
<li class="tsd-signature" id="export_.__type.file.__type-3.__type-4"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Returns the path to the settings file.</p>
<p>In general, the settings file is stored in your app&#39;s
user data directory in a file called <code>settings.json</code>.
The default user data directory varies by system.</p>
<ul>
<li><strong>macOS</strong> - <code>~/Library/Application\ Support/&lt;Your App&gt;</code></li>
<li><strong>Windows</strong> - <code>%APPDATA%/&lt;Your App&gt;</code></li>
<li><strong>Linux</strong> - Either <code>$XDG_CONFIG_HOME/&lt;Your App&gt;</code> or
<code>~/.config/&lt;Your App&gt;</code></li>
</ul>
<p>Although it is not recommended, you may change the name
or location of the settings file using
[[configure|configure()]].</p>

<h3>Returns</h3><p>The path to the settings file.</p>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Get</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">path</span><span class="hl-0"> </span><span class="hl-5">to</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0"> </span><span class="hl-5">file</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">file</span><span class="hl-0">();</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; /home/nathan/.config/MyApp/settings.json</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li></ul></li>
<li class="tsd-parameter">
<h5><span class="tsd-kind-property">get</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">SettingsObject</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">SettingsValue</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures">
<li class="tsd-signature" id="export_.__type.get.__type-5.__type-6"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">SettingsObject</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets all settings. For sync, use
[[getSync|getSync()]].</p>

<h3>Returns</h3><p>A promise which resolves with all settings.</p>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Gets</span><span class="hl-0"> </span><span class="hl-5">all</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">obj</span><span class="hl-0"> = </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-6">get</span><span class="hl-0">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">SettingsObject</span><span class="tsd-signature-symbol">&gt;</span></h4></li>
<li class="tsd-signature" id="export_.__type.get.__type-5.__type-7"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">SettingsValue</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the value at the given key path. For sync,
use [[getSync|getSync()]].</p>

<h3>Returns</h3><p>A promise which resolves with the value at the
given key path.</p>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Get</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-5">at</span><span class="hl-0"> </span><span class="hl-3">`color.name`</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-7">// Given:</span><br/><span class="hl-0">    </span><span class="hl-7">//</span><br/><span class="hl-0">    </span><span class="hl-7">// {</span><br/><span class="hl-0">    </span><span class="hl-7">//   &quot;color&quot;: {</span><br/><span class="hl-0">    </span><span class="hl-7">//     &quot;name&quot;: &quot;cerulean&quot;,</span><br/><span class="hl-0">    </span><span class="hl-7">//     &quot;code&quot;: {</span><br/><span class="hl-0">    </span><span class="hl-7">//       &quot;rgb&quot;: [0, 179, 230],</span><br/><span class="hl-0">    </span><span class="hl-7">//       &quot;hex&quot;: &quot;#003BE6&quot;</span><br/><span class="hl-0">    </span><span class="hl-7">//     }</span><br/><span class="hl-0">    </span><span class="hl-7">//   }</span><br/><span class="hl-0">    </span><span class="hl-7">// }</span><br/><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">value</span><span class="hl-0"> = </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">get</span><span class="hl-0">(</span><span class="hl-3">&#39;color.name&#39;</span><span class="hl-0">);</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; &quot;cerulean&quot;</span>
</code></pre>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Get</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-5">at</span><span class="hl-0"> </span><span class="hl-3">`color.hue`</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">h</span><span class="hl-0"> = </span><span class="hl-3">&#39;hue&#39;</span><span class="hl-0">;</span><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">value</span><span class="hl-0"> = </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">get</span><span class="hl-0">([</span><span class="hl-3">&#39;color&#39;</span><span class="hl-0">, </span><span class="hl-5">h</span><span class="hl-0">]);</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; undefined</span>
</code></pre>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Get</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-5">at</span><span class="hl-0"> </span><span class="hl-3">`color.code.rgb[1]`</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">h</span><span class="hl-0"> = </span><span class="hl-3">&#39;hue&#39;</span><span class="hl-0">;</span><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">value</span><span class="hl-0"> = </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">get</span><span class="hl-0">(</span><span class="hl-3">&#39;color.code.rgb[1]&#39;</span><span class="hl-0">);</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; 179</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">keyPath</span>: <span class="tsd-signature-type ">KeyPath</span></h5>
<div class="tsd-comment tsd-typography"><p>The key path of the property.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">SettingsValue</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li>
<li class="tsd-parameter">
<h5><span class="tsd-kind-property">get<wbr/>Sync</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">SettingsObject</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">SettingsValue</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures">
<li class="tsd-signature" id="export_.__type.getSync.__type-8.__type-9"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">SettingsObject</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets all settings. For async, use [[get|get()]].</p>

<h3>Returns</h3><p>All settings.</p>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Gets</span><span class="hl-0"> </span><span class="hl-5">all</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">obj</span><span class="hl-0"> = </span><span class="hl-6">getSync</span><span class="hl-0">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">SettingsObject</span></h4></li>
<li class="tsd-signature" id="export_.__type.getSync.__type-8.__type-10"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">SettingsValue</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the value at the given key path. For async,
use [[get|get()]].</p>

<h3>Returns</h3><p>The value at the given key path.</p>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Get</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-5">at</span><span class="hl-0"> </span><span class="hl-3">`color.name`</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-7">// Given:</span><br/><span class="hl-0">    </span><span class="hl-7">//</span><br/><span class="hl-0">    </span><span class="hl-7">// {</span><br/><span class="hl-0">    </span><span class="hl-7">//   &quot;color&quot;: {</span><br/><span class="hl-0">    </span><span class="hl-7">//     &quot;name&quot;: &quot;cerulean&quot;,</span><br/><span class="hl-0">    </span><span class="hl-7">//     &quot;code&quot;: {</span><br/><span class="hl-0">    </span><span class="hl-7">//       &quot;rgb&quot;: [0, 179, 230],</span><br/><span class="hl-0">    </span><span class="hl-7">//       &quot;hex&quot;: &quot;#003BE6&quot;</span><br/><span class="hl-0">    </span><span class="hl-7">//     }</span><br/><span class="hl-0">    </span><span class="hl-7">//   }</span><br/><span class="hl-0">    </span><span class="hl-7">// }</span><br/><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">value</span><span class="hl-0"> = </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">getSync</span><span class="hl-0">(</span><span class="hl-3">&#39;color.name&#39;</span><span class="hl-0">);</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; &quot;cerulean&quot;</span>
</code></pre>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Get</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-5">at</span><span class="hl-0"> </span><span class="hl-3">`color.hue`</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">h</span><span class="hl-0"> = </span><span class="hl-3">&#39;hue&#39;</span><span class="hl-0">;</span><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">value</span><span class="hl-0"> = </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">getSync</span><span class="hl-0">([</span><span class="hl-3">&#39;color&#39;</span><span class="hl-0">, </span><span class="hl-5">h</span><span class="hl-0">]);</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; undefined</span>
</code></pre>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Get</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-5">at</span><span class="hl-0"> </span><span class="hl-3">`color.code.rgb[1]`</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">h</span><span class="hl-0"> = </span><span class="hl-3">&#39;hue&#39;</span><span class="hl-0">;</span><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">value</span><span class="hl-0"> = </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">getSync</span><span class="hl-0">(</span><span class="hl-3">&#39;color.code.rgb[1]&#39;</span><span class="hl-0">);</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; 179</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">keyPath</span>: <span class="tsd-signature-type ">KeyPath</span></h5>
<div class="tsd-comment tsd-typography"><p>The key path of the property.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">SettingsValue</span></h4></li></ul></li></ul></li>
<li class="tsd-parameter">
<h5><span class="tsd-kind-property">has</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures">
<li class="tsd-signature" id="export_.__type.has.__type-11.__type-12"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Checks if the given key path exists. For sync,
use [[hasSync|hasSync()]].</p>

<h3>Returns</h3><p>A promise which resolves to <code>true</code> if the
<code>keyPath</code> exists, else <code>false</code>.</p>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Check</span><span class="hl-0"> </span><span class="hl-9">if</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-5">at</span><span class="hl-0"> </span><span class="hl-3">`color.name`</span><span class="hl-0"> </span><span class="hl-5">exists</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-7">// Given:</span><br/><span class="hl-0">    </span><span class="hl-7">//</span><br/><span class="hl-0">    </span><span class="hl-7">// {</span><br/><span class="hl-0">    </span><span class="hl-7">//   &quot;color&quot;: {</span><br/><span class="hl-0">    </span><span class="hl-7">//     &quot;name&quot;: &quot;cerulean&quot;,</span><br/><span class="hl-0">    </span><span class="hl-7">//     &quot;code&quot;: {</span><br/><span class="hl-0">    </span><span class="hl-7">//       &quot;rgb&quot;: [0, 179, 230],</span><br/><span class="hl-0">    </span><span class="hl-7">//       &quot;hex&quot;: &quot;#003BE6&quot;</span><br/><span class="hl-0">    </span><span class="hl-7">//     }</span><br/><span class="hl-0">    </span><span class="hl-7">//   }</span><br/><span class="hl-0">    </span><span class="hl-7">// }</span><br/><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">exists</span><span class="hl-0"> = </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">has</span><span class="hl-0">(</span><span class="hl-3">&#39;color.name&#39;</span><span class="hl-0">);</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; true</span>
</code></pre>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Check</span><span class="hl-0"> </span><span class="hl-9">if</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-5">at</span><span class="hl-0"> </span><span class="hl-3">`color.hue`</span><span class="hl-0"> </span><span class="hl-5">exists</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">h</span><span class="hl-0"> = </span><span class="hl-3">&#39;hue&#39;</span><span class="hl-0">;</span><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">exists</span><span class="hl-0"> = </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">has</span><span class="hl-0">([</span><span class="hl-3">&#39;color&#39;</span><span class="hl-0">, </span><span class="hl-5">h</span><span class="hl-0">]);</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; false</span>
</code></pre>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Check</span><span class="hl-0"> </span><span class="hl-9">if</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-5">at</span><span class="hl-0"> </span><span class="hl-3">`color.code.rgb[1]`</span><span class="hl-0"> </span><span class="hl-5">exists</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">exists</span><span class="hl-0"> = </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">has</span><span class="hl-0">(</span><span class="hl-5">color</span><span class="hl-0">.</span><span class="hl-5">code</span><span class="hl-0">.</span><span class="hl-5">rgb</span><span class="hl-0">[</span><span class="hl-4">1</span><span class="hl-0">]);</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; true</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">keyPath</span>: <span class="tsd-signature-type ">KeyPath</span></h5>
<div class="tsd-comment tsd-typography"><p>The key path to check.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li>
<li class="tsd-parameter">
<h5><span class="tsd-kind-property">has<wbr/>Sync</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures">
<li class="tsd-signature" id="export_.__type.hasSync.__type-13.__type-14"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Checks if the given key path exists. For async,
use [[hasSync|hasSync()]].</p>

<h3>Returns</h3><p><code>true</code> if the <code>keyPath</code> exists, else <code>false</code>.</p>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Check</span><span class="hl-0"> </span><span class="hl-9">if</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-5">at</span><span class="hl-0"> </span><span class="hl-3">`color.name`</span><span class="hl-0"> </span><span class="hl-5">exists</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-7">// Given:</span><br/><span class="hl-0">    </span><span class="hl-7">//</span><br/><span class="hl-0">    </span><span class="hl-7">// {</span><br/><span class="hl-0">    </span><span class="hl-7">//   &quot;color&quot;: {</span><br/><span class="hl-0">    </span><span class="hl-7">//     &quot;name&quot;: &quot;cerulean&quot;,</span><br/><span class="hl-0">    </span><span class="hl-7">//     &quot;code&quot;: {</span><br/><span class="hl-0">    </span><span class="hl-7">//       &quot;rgb&quot;: [0, 179, 230],</span><br/><span class="hl-0">    </span><span class="hl-7">//       &quot;hex&quot;: &quot;#003BE6&quot;</span><br/><span class="hl-0">    </span><span class="hl-7">//     }</span><br/><span class="hl-0">    </span><span class="hl-7">//   }</span><br/><span class="hl-0">    </span><span class="hl-7">// }</span><br/><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">exists</span><span class="hl-0"> = </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">hasSync</span><span class="hl-0">(</span><span class="hl-3">&#39;color.name&#39;</span><span class="hl-0">);</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; true</span>
</code></pre>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Check</span><span class="hl-0"> </span><span class="hl-9">if</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-5">at</span><span class="hl-0"> </span><span class="hl-3">`color.hue`</span><span class="hl-0"> </span><span class="hl-5">exists</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">h</span><span class="hl-0"> = </span><span class="hl-3">&#39;hue&#39;</span><span class="hl-0">;</span><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">exists</span><span class="hl-0"> = </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">hasSync</span><span class="hl-0">([</span><span class="hl-3">&#39;color&#39;</span><span class="hl-0">, </span><span class="hl-5">h</span><span class="hl-0">]);</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; false</span>
</code></pre>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Check</span><span class="hl-0"> </span><span class="hl-9">if</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-5">at</span><span class="hl-0"> </span><span class="hl-3">`color.code.rgb[1]`</span><span class="hl-0"> </span><span class="hl-5">exists</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">exists</span><span class="hl-0"> = </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">hasSync</span><span class="hl-0">(</span><span class="hl-5">color</span><span class="hl-0">.</span><span class="hl-5">code</span><span class="hl-0">.</span><span class="hl-5">rgb</span><span class="hl-0">[</span><span class="hl-4">1</span><span class="hl-0">]);</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; true</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">keyPath</span>: <span class="tsd-signature-type ">KeyPath</span></h5>
<div class="tsd-comment tsd-typography"><p>The key path to check.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></li>
<li class="tsd-parameter">
<h5><span class="tsd-kind-property">reset</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures">
<li class="tsd-signature" id="export_.__type.reset.__type-15.__type-16"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Resets the Electron Settings configuration to defaults.</p>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Reset</span><span class="hl-0"> </span><span class="hl-5">configuration</span><span class="hl-0"> </span><span class="hl-5">to</span><span class="hl-0"> </span><span class="hl-5">defaults</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">reset</span><span class="hl-0">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li>
<li class="tsd-parameter">
<h5><span class="tsd-kind-property">set</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span>, <span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures">
<li class="tsd-signature" id="export_.__type.set.__type-17.__type-18"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Sets all settings. For sync, use [[setSync|setSync()]].</p>

<h3>Returns</h3><p>A promise which resolves when the settings have
been set.</p>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Set</span><span class="hl-0"> </span><span class="hl-5">all</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">set</span><span class="hl-0">({ </span><span class="hl-5">aqpw:</span><span class="hl-0"> </span><span class="hl-3">&#39;nice&#39;</span><span class="hl-0"> });</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">obj</span>: <span class="tsd-signature-type ">SettingsObject</span></h5>
<div class="tsd-comment tsd-typography"><p>The new settings.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li>
<li class="tsd-signature" id="export_.__type.set.__type-17.__type-19"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span>, <span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Sets the value at the given key path. For sync,
use [[setSync|setSync()]].</p>

<h3>Returns</h3><p>A promise which resolves when the setting has
been set.</p>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Change</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-5">at</span><span class="hl-0"> </span><span class="hl-3">`color.name`</span><span class="hl-0"> </span><span class="hl-5">to</span><span class="hl-0"> </span><span class="hl-3">`sapphire`</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-7">// Given:</span><br/><span class="hl-0">    </span><span class="hl-7">//</span><br/><span class="hl-0">    </span><span class="hl-7">// {</span><br/><span class="hl-0">    </span><span class="hl-7">//   &quot;color&quot;: {</span><br/><span class="hl-0">    </span><span class="hl-7">//     &quot;name&quot;: &quot;cerulean&quot;,</span><br/><span class="hl-0">    </span><span class="hl-7">//     &quot;code&quot;: {</span><br/><span class="hl-0">    </span><span class="hl-7">//       &quot;rgb&quot;: [0, 179, 230],</span><br/><span class="hl-0">    </span><span class="hl-7">//       &quot;hex&quot;: &quot;#003BE6&quot;</span><br/><span class="hl-0">    </span><span class="hl-7">//     }</span><br/><span class="hl-0">    </span><span class="hl-7">//   }</span><br/><span class="hl-0">    </span><span class="hl-7">// }</span><br/><br/><span class="hl-0">    </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">set</span><span class="hl-0">(</span><span class="hl-3">&#39;color.name&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;sapphire&#39;</span><span class="hl-0">);</span>
</code></pre>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Set</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-2">of</span><span class="hl-0"> </span><span class="hl-3">`color.hue`</span><span class="hl-0"> </span><span class="hl-5">to</span><span class="hl-0"> </span><span class="hl-3">`blue-ish`</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">h</span><span class="hl-0"> = </span><span class="hl-3">&#39;hue&#39;</span><span class="hl-0">;</span><br/><span class="hl-0">    </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">set</span><span class="hl-0">([</span><span class="hl-3">&#39;color&#39;</span><span class="hl-0">, </span><span class="hl-5">h</span><span class="hl-0">], </span><span class="hl-3">&#39;blue-ish)</span><span class="hl-10">;</span>
</code></pre>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Change</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-2">of</span><span class="hl-0"> </span><span class="hl-3">`color.code`</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">set</span><span class="hl-0">(</span><span class="hl-3">&#39;color.code&#39;</span><span class="hl-0">, {</span><br/><span class="hl-0">      </span><span class="hl-5">rgb:</span><span class="hl-0"> [</span><span class="hl-4">16</span><span class="hl-0">, </span><span class="hl-4">31</span><span class="hl-0">, </span><span class="hl-4">134</span><span class="hl-0">],</span><br/><span class="hl-0">      </span><span class="hl-5">hex:</span><span class="hl-0"> </span><span class="hl-3">&#39;#101F86&#39;</span><br/><span class="hl-0">    });</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">keyPath</span>: <span class="tsd-signature-type ">KeyPath</span></h5>
<div class="tsd-comment tsd-typography"><p>The key path of the property.</p>
</div></li>
<li>
<h5><span class="tsd-kind-parameter">obj</span>: <span class="tsd-signature-type ">SettingsValue</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li>
<li class="tsd-parameter">
<h5><span class="tsd-kind-property">set<wbr/>Sync</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures">
<li class="tsd-signature" id="export_.__type.setSync.__type-20.__type-21"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Sets all settings. For async, use [[set|set()]].</p>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Set</span><span class="hl-0"> </span><span class="hl-5">all</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">setSync</span><span class="hl-0">({ </span><span class="hl-5">aqpw:</span><span class="hl-0"> </span><span class="hl-3">&#39;nice&#39;</span><span class="hl-0"> });</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">obj</span>: <span class="tsd-signature-type ">SettingsObject</span></h5>
<div class="tsd-comment tsd-typography"><p>The new settings.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li>
<li class="tsd-signature" id="export_.__type.setSync.__type-20.__type-22"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Sets the value at the given key path. For async,
use [[set|set()]].</p>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Change</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-5">at</span><span class="hl-0"> </span><span class="hl-3">`color.name`</span><span class="hl-0"> </span><span class="hl-5">to</span><span class="hl-0"> </span><span class="hl-3">`sapphire`</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-7">// Given:</span><br/><span class="hl-0">    </span><span class="hl-7">//</span><br/><span class="hl-0">    </span><span class="hl-7">// {</span><br/><span class="hl-0">    </span><span class="hl-7">//   &quot;color&quot;: {</span><br/><span class="hl-0">    </span><span class="hl-7">//     &quot;name&quot;: &quot;cerulean&quot;,</span><br/><span class="hl-0">    </span><span class="hl-7">//     &quot;code&quot;: {</span><br/><span class="hl-0">    </span><span class="hl-7">//       &quot;rgb&quot;: [0, 179, 230],</span><br/><span class="hl-0">    </span><span class="hl-7">//       &quot;hex&quot;: &quot;#003BE6&quot;</span><br/><span class="hl-0">    </span><span class="hl-7">//     }</span><br/><span class="hl-0">    </span><span class="hl-7">//   }</span><br/><span class="hl-0">    </span><span class="hl-7">// }</span><br/><br/><span class="hl-0">    </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">setSync</span><span class="hl-0">(</span><span class="hl-3">&#39;color.name&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;sapphire&#39;</span><span class="hl-0">);</span>
</code></pre>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Set</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-2">of</span><span class="hl-0"> </span><span class="hl-3">`color.hue`</span><span class="hl-0"> </span><span class="hl-5">to</span><span class="hl-0"> </span><span class="hl-3">`blue-ish`</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-8">h</span><span class="hl-0"> = </span><span class="hl-3">&#39;hue&#39;</span><span class="hl-0">;</span><br/><span class="hl-0">    </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">setSync</span><span class="hl-0">([</span><span class="hl-3">&#39;color&#39;</span><span class="hl-0">, </span><span class="hl-5">h</span><span class="hl-0">], </span><span class="hl-3">&#39;blue-ish)</span><span class="hl-10">;</span>
</code></pre>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Change</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> </span><span class="hl-2">of</span><span class="hl-0"> </span><span class="hl-3">`color.code`</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">setSync</span><span class="hl-0">(</span><span class="hl-3">&#39;color.code&#39;</span><span class="hl-0">, {</span><br/><span class="hl-0">      </span><span class="hl-5">rgb:</span><span class="hl-0"> [</span><span class="hl-4">16</span><span class="hl-0">, </span><span class="hl-4">31</span><span class="hl-0">, </span><span class="hl-4">134</span><span class="hl-0">],</span><br/><span class="hl-0">      </span><span class="hl-5">hex:</span><span class="hl-0"> </span><span class="hl-3">&#39;#101F86&#39;</span><br/><span class="hl-0">    });</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">keyPath</span>: <span class="tsd-signature-type ">KeyPath</span></h5>
<div class="tsd-comment tsd-typography"><p>The key path of the property.</p>
</div></li>
<li>
<h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type ">SettingsValue</span></h5>
<div class="tsd-comment tsd-typography"><p>The value to set.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li>
<li class="tsd-parameter">
<h5><span class="tsd-kind-property">unset</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures">
<li class="tsd-signature" id="export_.__type.unset.__type-23.__type-24"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Unsets all settings. For sync, use [[unsetSync|unsetSync()]].</p>

<h3>Returns</h3><p>A promise which resolves when the settings have
been unset.</p>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Unsets</span><span class="hl-0"> </span><span class="hl-5">all</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">unset</span><span class="hl-0">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li>
<li class="tsd-signature" id="export_.__type.unset.__type-23.__type-25"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Unsets the property at the given key path. For sync,
use [[unsetSync|unsetSync()]].</p>

<h3>Returns</h3><p>A promise which resolves when the setting has
been unset.</p>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Unset</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">property</span><span class="hl-0"> </span><span class="hl-3">`color.name`</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-7">// Given:</span><br/><span class="hl-0">    </span><span class="hl-7">//</span><br/><span class="hl-0">    </span><span class="hl-7">// {</span><br/><span class="hl-0">    </span><span class="hl-7">//   &quot;color&quot;: {</span><br/><span class="hl-0">    </span><span class="hl-7">//     &quot;name&quot;: &quot;cerulean&quot;,</span><br/><span class="hl-0">    </span><span class="hl-7">//     &quot;code&quot;: {</span><br/><span class="hl-0">    </span><span class="hl-7">//       &quot;rgb&quot;: [0, 179, 230],</span><br/><span class="hl-0">    </span><span class="hl-7">//       &quot;hex&quot;: &quot;#003BE6&quot;</span><br/><span class="hl-0">    </span><span class="hl-7">//     }</span><br/><span class="hl-0">    </span><span class="hl-7">//   }</span><br/><span class="hl-0">    </span><span class="hl-7">// }</span><br/><br/><span class="hl-0">    </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">unset</span><span class="hl-0">(</span><span class="hl-3">&#39;color.name&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-0">    </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">get</span><span class="hl-0">(</span><span class="hl-3">&#39;color.name&#39;</span><span class="hl-0">);</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; undefined</span>
</code></pre>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Unset</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">property</span><span class="hl-0"> </span><span class="hl-3">`color.code.rgba[1]`</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">unset</span><span class="hl-0">(</span><span class="hl-3">&#39;color.code.rgba[1]&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-0">    </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">get</span><span class="hl-0">(</span><span class="hl-3">&#39;color.code.rgb&#39;</span><span class="hl-0">);</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; [0, null, 230]</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">keyPath</span>: <span class="tsd-signature-type ">KeyPath</span></h5>
<div class="tsd-comment tsd-typography"><p>The key path of the property.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li>
<li class="tsd-parameter">
<h5><span class="tsd-kind-property">unset<wbr/>Sync</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures">
<li class="tsd-signature" id="export_.__type.unsetSync.__type-26.__type-27"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Unsets all settings. For async, use [[unset|unset()]].</p>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Unsets</span><span class="hl-0"> </span><span class="hl-5">all</span><span class="hl-0"> </span><span class="hl-5">settings</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">unsetSync</span><span class="hl-0">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li>
<li class="tsd-signature" id="export_.__type.unsetSync.__type-26.__type-28"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Unsets the property at the given key path. For async,
use [[unset|unset()]].</p>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Unset</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">property</span><span class="hl-0"> </span><span class="hl-3">`color.name`</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-7">// Given:</span><br/><span class="hl-0">    </span><span class="hl-7">//</span><br/><span class="hl-0">    </span><span class="hl-7">// {</span><br/><span class="hl-0">    </span><span class="hl-7">//   &quot;color&quot;: {</span><br/><span class="hl-0">    </span><span class="hl-7">//     &quot;name&quot;: &quot;cerulean&quot;,</span><br/><span class="hl-0">    </span><span class="hl-7">//     &quot;code&quot;: {</span><br/><span class="hl-0">    </span><span class="hl-7">//       &quot;rgb&quot;: [0, 179, 230],</span><br/><span class="hl-0">    </span><span class="hl-7">//       &quot;hex&quot;: &quot;#003BE6&quot;</span><br/><span class="hl-0">    </span><span class="hl-7">//     }</span><br/><span class="hl-0">    </span><span class="hl-7">//   }</span><br/><span class="hl-0">    </span><span class="hl-7">// }</span><br/><br/><span class="hl-0">    </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">unsetSync</span><span class="hl-0">(</span><span class="hl-3">&#39;color.name&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-0">    </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">getSync</span><span class="hl-0">(</span><span class="hl-3">&#39;color.name&#39;</span><span class="hl-0">);</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; undefined</span>
</code></pre>

<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">Unset</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">property</span><span class="hl-0"> </span><span class="hl-3">`color.code.rgba[1]`</span><span class="hl-0">.</span><br/><br/><span class="hl-0">    </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">unsetSync</span><span class="hl-0">(</span><span class="hl-3">&#39;color.code.rgba[1]&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-0">    </span><span class="hl-5">settings</span><span class="hl-0">.</span><span class="hl-6">getSync</span><span class="hl-0">(</span><span class="hl-3">&#39;color.code.rgb&#39;</span><span class="hl-0">);</span><br/><span class="hl-0">    </span><span class="hl-7">// =&gt; [0, null, 230]</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">keyPath</span>: <span class="tsd-signature-type ">KeyPath</span></h5>
<div class="tsd-comment tsd-typography"><p>The key path of the property.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nathanbuchar/electron-settings/blob/e956963/src/settings.ts#L946">settings.ts:946</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg>Settings</h3></summary>
<div class="tsd-accordion-details">
<div class="tsd-filter-visibility">
<h4 class="uppercase">Member Visibility</h4><form>
<ul id="tsd-filter-options">
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
<div class="tsd-theme-toggle">
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg>On This Page</h3></summary>
<div class="tsd-accordion-details">
<ul>
<li><a href="#export_" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>export=</span></a></li></ul></div></details></div>
<div class="site-menu">
<nav class="tsd-navigation"><a href="index.html" class="current"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4-path"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)" id="icon-4-text"></path></svg><span>Electron <wbr/>Settings -<wbr/> v5.0.0</span></a>
<ul class="tsd-small-nested-navigation">
<li><a href="index.html#export_"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>export=</span></a></li></ul></nav></div></div></div>
<div class="tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
<div class="overlay"></div></body></html>